home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Online / Epic4 / share / epic / help / 6_functions / usermode < prev    next >
Text File  |  2001-03-21  |  1KB  |  28 lines
  1. Synopsis:
  2.    $usermode([<server>])
  3.  
  4. Technical:
  5.    This function returns the client's current user mode for the specified
  6.    server.  It will accept either a server name or list number.  If no
  7.    server is given, the one for the current window is assumed.
  8.  
  9. Practical:
  10.    The information returned with this function is identical to the
  11.    contents of STATUS_UMODE in the status bar for the current server.  It's
  12.    useful for getting the current usermodes for hidden windows without
  13.    switching to them.  It is useful when used in conjunction with
  14.    $winserv().
  15.  
  16. Returns:
  17.    user mode string for current server (nothing if bad server or no modes)
  18.  
  19. Examples:
  20.    $usermode()                      shows user mode for current server
  21.    $usermode(2)                     shows user mode for server #2
  22.    $usermode(irc.blah.com)          shows user mode on irc.blah.com
  23.    $usermode(irc.fakeserver.com)    no such server, returns nothing
  24.  
  25. See Also:
  26.    mode(1); set(4) status_umode; winserv(6)
  27.  
  28.